<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>PageResult xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/name/pehl/taoki/rest/paging/PageResult.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong class="jxr_keyword">package</strong> name.pehl.taoki.<strong class="jxr_keyword">rest</strong>.paging;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> java.lang.Math.max;
<a name="4" href="#4">4</a>   <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> java.lang.Math.min;
<a name="5" href="#5">5</a>   
<a name="6" href="#6">6</a>   <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a name="7" href="#7">7</a>   <strong class="jxr_keyword">import</strong> java.util.Collection;
<a name="8" href="#8">8</a>   <strong class="jxr_keyword">import</strong> java.util.Collections;
<a name="9" href="#9">9</a>   <strong class="jxr_keyword">import</strong> java.util.Iterator;
<a name="10" href="#10">10</a>  <strong class="jxr_keyword">import</strong> java.util.List;
<a name="11" href="#11">11</a>  <strong class="jxr_keyword">import</strong> java.util.ListIterator;
<a name="12" href="#12">12</a>  
<a name="13" href="#13">13</a>  <em class="jxr_javadoccomment">/**</em>
<a name="14" href="#14">14</a>  <em class="jxr_javadoccomment"> * Contains the results for one page of a larger dataset based on a</em>
<a name="15" href="#15">15</a>  <em class="jxr_javadoccomment"> * {@link PageInfo} instance.</em>
<a name="16" href="#16">16</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="17" href="#17">17</a>  <em class="jxr_javadoccomment"> * The internal state and behaviour of this class depends on the constructor</em>
<a name="18" href="#18">18</a>  <em class="jxr_javadoccomment"> * called:</em>
<a name="19" href="#19">19</a>  <em class="jxr_javadoccomment"> * &lt;ol&gt;</em>
<a name="20" href="#20">20</a>  <em class="jxr_javadoccomment"> * &lt;li&gt;{@link #PageResult(PageInfo, List)}&lt;br/&gt;</em>
<a name="21" href="#21">21</a>  <em class="jxr_javadoccomment"> * In this mode the complete data is known. The methods {@link #first()},</em>
<a name="22" href="#22">22</a>  <em class="jxr_javadoccomment"> * {@link #previous()}, {@link #page(int)}, {@link #next()} and {@link #last()}</em>
<a name="23" href="#23">23</a>  <em class="jxr_javadoccomment"> * can be used to navigate over the data.</em>
<a name="24" href="#24">24</a>  <em class="jxr_javadoccomment"> * &lt;li&gt;{@link #PageResult(PageInfo, List, int)}&lt;br/&gt;</em>
<a name="25" href="#25">25</a>  <em class="jxr_javadoccomment"> * In this mode only the data of the specified page is known. The methods</em>
<a name="26" href="#26">26</a>  <em class="jxr_javadoccomment"> * {@link #first()}, {@link #previous()}, {@link #page(int)}, {@link #next()}</em>
<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment"> * and {@link #last()} all return &lt;code&gt;null&lt;/code&gt;.</em>
<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> * &lt;/ol&gt;</em>
<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> * </em>
<a name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> * @param &lt;T&gt;</em>
<a name="31" href="#31">31</a>  <em class="jxr_javadoccomment"> *            The type of the result</em>
<a name="32" href="#32">32</a>  <em class="jxr_javadoccomment"> * @author $Author: harald.pehl $</em>
<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment"> * @version $Date: 2010-09-06 22:17:50 +0200 (Mo, 06 Sep 2010) $</em>
<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment"> */</em>
<a name="35" href="#35">35</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> PageResult&lt;T&gt; implements Iterable&lt;T&gt;
<a name="36" href="#36">36</a>  {
<a name="37" href="#37">37</a>      <em class="jxr_comment">// -------------------------------------------------------------- constants</em>
<a name="38" href="#38">38</a>  
<a name="39" href="#39">39</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> MIN_TOTAL = 0;
<a name="40" href="#40">40</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> MAX_TOTAL = 0xffffff;
<a name="41" href="#41">41</a>  
<a name="42" href="#42">42</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = 1L;
<a name="43" href="#43">43</a>  
<a name="44" href="#44">44</a>      <em class="jxr_comment">// -------------------------------------------------------- private members</em>
<a name="45" href="#45">45</a>  
<a name="46" href="#46">46</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../name/pehl/taoki/rest/paging/PageInfo.html">PageInfo</a> pageInfo;
<a name="47" href="#47">47</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> List&lt;T&gt; all;
<a name="48" href="#48">48</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> List&lt;T&gt; page;
<a name="49" href="#49">49</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> pages;
<a name="50" href="#50">50</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> total;
<a name="51" href="#51">51</a>  
<a name="52" href="#52">52</a>  
<a name="53" href="#53">53</a>      <em class="jxr_comment">// ----------------------------------------------------------- constructors</em>
<a name="54" href="#54">54</a>  
<a name="55" href="#55">55</a>      <em class="jxr_javadoccomment">/**</em>
<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment">     * Creates a new instance which contains one page from {@code all} according</em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment">     * to {@code pageInfo}. The specified list is expected to contain all data</em>
<a name="58" href="#58">58</a>  <em class="jxr_javadoccomment">     * and is used when navigating over it by calling {@link #first()},</em>
<a name="59" href="#59">59</a>  <em class="jxr_javadoccomment">     * {@link #previous()}, {@link #page(int)}, {@link #next()} and</em>
<a name="60" href="#60">60</a>  <em class="jxr_javadoccomment">     * {@link #last()}. The {@linkplain #total() total number of records} is</em>
<a name="61" href="#61">61</a>  <em class="jxr_javadoccomment">     * computed from &lt;code&gt;all.size()&lt;/code&gt;.</em>
<a name="62" href="#62">62</a>  <em class="jxr_javadoccomment">     * </em>
<a name="63" href="#63">63</a>  <em class="jxr_javadoccomment">     * @param pageInfo</em>
<a name="64" href="#64">64</a>  <em class="jxr_javadoccomment">     *            The pageInfo instance which is used to create the sublist.</em>
<a name="65" href="#65">65</a>  <em class="jxr_javadoccomment">     *            Must not be &lt;code&gt;null&lt;/code&gt;!</em>
<a name="66" href="#66">66</a>  <em class="jxr_javadoccomment">     * @param all</em>
<a name="67" href="#67">67</a>  <em class="jxr_javadoccomment">     *            The complete list. Might be &lt;code&gt;null&lt;/code&gt;. In this case</em>
<a name="68" href="#68">68</a>  <em class="jxr_javadoccomment">     *            {@link #total()} will return 0, {@link #page()} will return an</em>
<a name="69" href="#69">69</a>  <em class="jxr_javadoccomment">     *            empty list, {@link #isNavigable()} will return</em>
<a name="70" href="#70">70</a>  <em class="jxr_javadoccomment">     *            &lt;code&gt;false&lt;/code&gt; and {@link #first()}, {@link #previous()},</em>
<a name="71" href="#71">71</a>  <em class="jxr_javadoccomment">     *            {@link #page(int)}, {@link #next()} and {@link #last()} will</em>
<a name="72" href="#72">72</a>  <em class="jxr_javadoccomment">     *            all return &lt;code&gt;null&lt;/code&gt;.</em>
<a name="73" href="#73">73</a>  <em class="jxr_javadoccomment">     * @throws IllegalArgumentException</em>
<a name="74" href="#74">74</a>  <em class="jxr_javadoccomment">     *             if {@code pageInfo} is &lt;code&gt;null&lt;/code&gt;.</em>
<a name="75" href="#75">75</a>  <em class="jxr_javadoccomment">     */</em>
<a name="76" href="#76">76</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../../name/pehl/taoki/rest/paging/PageResult.html">PageResult</a>(<strong class="jxr_keyword">final</strong> <a href="../../../../../name/pehl/taoki/rest/paging/PageInfo.html">PageInfo</a> pageInfo, <strong class="jxr_keyword">final</strong> List&lt;T&gt; all)
<a name="77" href="#77">77</a>      {
<a name="78" href="#78">78</a>          <strong class="jxr_keyword">this</strong>.pageInfo = checkPageInfo(pageInfo);
<a name="79" href="#79">79</a>          <strong class="jxr_keyword">this</strong>.all = all;
<a name="80" href="#80">80</a>          <strong class="jxr_keyword">if</strong> (all != <strong class="jxr_keyword">null</strong>)
<a name="81" href="#81">81</a>          {
<a name="82" href="#82">82</a>              <strong class="jxr_keyword">this</strong>.total = all.size();
<a name="83" href="#83">83</a>              <strong class="jxr_keyword">if</strong> (total % pageInfo.getPageSize() == 0)
<a name="84" href="#84">84</a>              {
<a name="85" href="#85">85</a>                  <strong class="jxr_keyword">this</strong>.pages = max(1, total / pageInfo.getPageSize());
<a name="86" href="#86">86</a>              }
<a name="87" href="#87">87</a>              <strong class="jxr_keyword">else</strong>
<a name="88" href="#88">88</a>              {
<a name="89" href="#89">89</a>                  <strong class="jxr_keyword">this</strong>.pages = 1 + total / pageInfo.getPageSize();
<a name="90" href="#90">90</a>              }
<a name="91" href="#91">91</a>              <strong class="jxr_keyword">this</strong>.page = sublist(pageInfo, all);
<a name="92" href="#92">92</a>          }
<a name="93" href="#93">93</a>          <strong class="jxr_keyword">else</strong>
<a name="94" href="#94">94</a>          {
<a name="95" href="#95">95</a>              <strong class="jxr_keyword">this</strong>.total = 0;
<a name="96" href="#96">96</a>              <strong class="jxr_keyword">this</strong>.pages = 1;
<a name="97" href="#97">97</a>              <strong class="jxr_keyword">this</strong>.page = Collections.emptyList();
<a name="98" href="#98">98</a>          }
<a name="99" href="#99">99</a>      }
<a name="100" href="#100">100</a> 
<a name="101" href="#101">101</a> 
<a name="102" href="#102">102</a>     <em class="jxr_javadoccomment">/**</em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment">     * Creates a new instance with exactly the specified data. The complete data</em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment">     * is unknown to the created instance and thus the methods {@link #first()},</em>
<a name="105" href="#105">105</a> <em class="jxr_javadoccomment">     * {@link #previous()}, {@link #page(int)}, {@link #next()} and</em>
<a name="106" href="#106">106</a> <em class="jxr_javadoccomment">     * {@link #last()} will all return &lt;code&gt;null&lt;/code&gt;. The</em>
<a name="107" href="#107">107</a> <em class="jxr_javadoccomment">     * {@linkplain #total() total number of records} must be specified by the</em>
<a name="108" href="#108">108</a> <em class="jxr_javadoccomment">     * parameter {@code total}. It must be &amp;gt;</em>
<a name="109" href="#109">109</a> <em class="jxr_javadoccomment">     * </em>
<a name="110" href="#110">110</a> <em class="jxr_javadoccomment">     * @param pageInfo</em>
<a name="111" href="#111">111</a> <em class="jxr_javadoccomment">     *            The pageInfo instance. Only {@link PageInfo#getPageSize()} is</em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">     *            used to shorten the list in case</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment">     *            &lt;code&gt;page.size &amp;gt; pageInfo.getLimit()&lt;/code&gt;. Must not be</em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment">     *            &lt;code&gt;null&lt;/code&gt;</em>
<a name="115" href="#115">115</a> <em class="jxr_javadoccomment">     * @param page</em>
<a name="116" href="#116">116</a> <em class="jxr_javadoccomment">     *            The data for this page.</em>
<a name="117" href="#117">117</a> <em class="jxr_javadoccomment">     * @param total</em>
<a name="118" href="#118">118</a> <em class="jxr_javadoccomment">     *            The total number of records as it cannot be calculated in this</em>
<a name="119" href="#119">119</a> <em class="jxr_javadoccomment">     *            case.</em>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException</em>
<a name="121" href="#121">121</a> <em class="jxr_javadoccomment">     *             if {@code pageInfo} is &lt;code&gt;null&lt;/code&gt;.</em>
<a name="122" href="#122">122</a> <em class="jxr_javadoccomment">     */</em>
<a name="123" href="#123">123</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../name/pehl/taoki/rest/paging/PageResult.html">PageResult</a>(<strong class="jxr_keyword">final</strong> <a href="../../../../../name/pehl/taoki/rest/paging/PageInfo.html">PageInfo</a> pageInfo, <strong class="jxr_keyword">final</strong> List&lt;T&gt; page, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> total)
<a name="124" href="#124">124</a>     {
<a name="125" href="#125">125</a>         <strong class="jxr_keyword">this</strong>.pageInfo = checkPageInfo(pageInfo);
<a name="126" href="#126">126</a>         <strong class="jxr_keyword">this</strong>.all = <strong class="jxr_keyword">null</strong>;
<a name="127" href="#127">127</a>         <strong class="jxr_keyword">int</strong> validTotal = 0;
<a name="128" href="#128">128</a>         <strong class="jxr_keyword">if</strong> (total &lt; MIN_TOTAL)
<a name="129" href="#129">129</a>         {
<a name="130" href="#130">130</a>             validTotal = MIN_TOTAL;
<a name="131" href="#131">131</a>         }
<a name="132" href="#132">132</a>         <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (total &gt; MAX_TOTAL)
<a name="133" href="#133">133</a>         {
<a name="134" href="#134">134</a>             validTotal = MAX_TOTAL;
<a name="135" href="#135">135</a>         }
<a name="136" href="#136">136</a>         <strong class="jxr_keyword">else</strong>
<a name="137" href="#137">137</a>         {
<a name="138" href="#138">138</a>             validTotal = total;
<a name="139" href="#139">139</a>         }
<a name="140" href="#140">140</a>         <strong class="jxr_keyword">if</strong> (page != <strong class="jxr_keyword">null</strong>)
<a name="141" href="#141">141</a>         {
<a name="142" href="#142">142</a>             <strong class="jxr_keyword">this</strong>.page = <strong class="jxr_keyword">new</strong> ArrayList&lt;T&gt;(page.subList(0, min(page.size(), pageInfo.getPageSize())));
<a name="143" href="#143">143</a>             <strong class="jxr_keyword">this</strong>.total = max(validTotal, page.size());
<a name="144" href="#144">144</a>         }
<a name="145" href="#145">145</a>         <strong class="jxr_keyword">else</strong>
<a name="146" href="#146">146</a>         {
<a name="147" href="#147">147</a>             <strong class="jxr_keyword">this</strong>.page = Collections.emptyList();
<a name="148" href="#148">148</a>             <strong class="jxr_keyword">this</strong>.total = validTotal;
<a name="149" href="#149">149</a>         }
<a name="150" href="#150">150</a>         <strong class="jxr_keyword">this</strong>.pages = 1;
<a name="151" href="#151">151</a>     }
<a name="152" href="#152">152</a> 
<a name="153" href="#153">153</a> 
<a name="154" href="#154">154</a>     <em class="jxr_comment">// --------------------------------------------------------- object methods</em>
<a name="155" href="#155">155</a> 
<a name="156" href="#156">156</a>     <em class="jxr_javadoccomment">/**</em>
<a name="157" href="#157">157</a> <em class="jxr_javadoccomment">     * Based on {@link #pageInfo}, {@link #page()} and {@link #total()}.</em>
<a name="158" href="#158">158</a> <em class="jxr_javadoccomment">     * </em>
<a name="159" href="#159">159</a> <em class="jxr_javadoccomment">     * @return the hash code based on {@link #pageInfo}, {@link #page()} and</em>
<a name="160" href="#160">160</a> <em class="jxr_javadoccomment">     *         {@link #total()}.</em>
<a name="161" href="#161">161</a> <em class="jxr_javadoccomment">     * @see java.lang.Object#hashCode()</em>
<a name="162" href="#162">162</a> <em class="jxr_javadoccomment">     */</em>
<a name="163" href="#163">163</a>     @Override
<a name="164" href="#164">164</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> hashCode()
<a name="165" href="#165">165</a>     {
<a name="166" href="#166">166</a>         <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> prime = 31;
<a name="167" href="#167">167</a>         <strong class="jxr_keyword">int</strong> result = 1;
<a name="168" href="#168">168</a>         result = prime * result + ((pageInfo == <strong class="jxr_keyword">null</strong>) ? 0 : pageInfo.hashCode());
<a name="169" href="#169">169</a>         result = prime * result + ((page == <strong class="jxr_keyword">null</strong>) ? 0 : page.hashCode());
<a name="170" href="#170">170</a>         result = prime * result + total;
<a name="171" href="#171">171</a>         <strong class="jxr_keyword">return</strong> result;
<a name="172" href="#172">172</a>     }
<a name="173" href="#173">173</a> 
<a name="174" href="#174">174</a> 
<a name="175" href="#175">175</a>     <em class="jxr_javadoccomment">/**</em>
<a name="176" href="#176">176</a> <em class="jxr_javadoccomment">     * Based on {@link #pageInfo}, {@link #page()} and {@link #total()}.</em>
<a name="177" href="#177">177</a> <em class="jxr_javadoccomment">     * </em>
<a name="178" href="#178">178</a> <em class="jxr_javadoccomment">     * @param o</em>
<a name="179" href="#179">179</a> <em class="jxr_javadoccomment">     *            the other {@link PageResult} instance</em>
<a name="180" href="#180">180</a> <em class="jxr_javadoccomment">     * @return &lt;code&gt;true&lt;/code&gt; if this instance equals {@code o},</em>
<a name="181" href="#181">181</a> <em class="jxr_javadoccomment">     *         &lt;code&gt;false&lt;/code&gt; otherwise.</em>
<a name="182" href="#182">182</a> <em class="jxr_javadoccomment">     * @see java.lang.Object#equals(java.lang.Object)</em>
<a name="183" href="#183">183</a> <em class="jxr_javadoccomment">     */</em>
<a name="184" href="#184">184</a>     @Override
<a name="185" href="#185">185</a>     @SuppressWarnings(<span class="jxr_string">"unchecked"</span>)
<a name="186" href="#186">186</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> equals(Object o)
<a name="187" href="#187">187</a>     {
<a name="188" href="#188">188</a>         <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong> == o)
<a name="189" href="#189">189</a>         {
<a name="190" href="#190">190</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="191" href="#191">191</a>         }
<a name="192" href="#192">192</a>         <strong class="jxr_keyword">if</strong> (o == <strong class="jxr_keyword">null</strong>)
<a name="193" href="#193">193</a>         {
<a name="194" href="#194">194</a>             <strong class="jxr_keyword">return</strong> false;
<a name="195" href="#195">195</a>         }
<a name="196" href="#196">196</a>         <strong class="jxr_keyword">if</strong> (getClass() != o.getClass())
<a name="197" href="#197">197</a>         {
<a name="198" href="#198">198</a>             <strong class="jxr_keyword">return</strong> false;
<a name="199" href="#199">199</a>         }
<a name="200" href="#200">200</a>         PageResult&lt;T&gt; other = (PageResult&lt;T&gt;) o;
<a name="201" href="#201">201</a>         <strong class="jxr_keyword">if</strong> (page == <strong class="jxr_keyword">null</strong>)
<a name="202" href="#202">202</a>         {
<a name="203" href="#203">203</a>             <strong class="jxr_keyword">if</strong> (other.page != <strong class="jxr_keyword">null</strong>)
<a name="204" href="#204">204</a>             {
<a name="205" href="#205">205</a>                 <strong class="jxr_keyword">return</strong> false;
<a name="206" href="#206">206</a>             }
<a name="207" href="#207">207</a>         }
<a name="208" href="#208">208</a>         <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (!page.equals(other.page))
<a name="209" href="#209">209</a>         {
<a name="210" href="#210">210</a>             <strong class="jxr_keyword">return</strong> false;
<a name="211" href="#211">211</a>         }
<a name="212" href="#212">212</a>         <strong class="jxr_keyword">if</strong> (pageInfo == <strong class="jxr_keyword">null</strong>)
<a name="213" href="#213">213</a>         {
<a name="214" href="#214">214</a>             <strong class="jxr_keyword">if</strong> (other.pageInfo != <strong class="jxr_keyword">null</strong>)
<a name="215" href="#215">215</a>             {
<a name="216" href="#216">216</a>                 <strong class="jxr_keyword">return</strong> false;
<a name="217" href="#217">217</a>             }
<a name="218" href="#218">218</a>         }
<a name="219" href="#219">219</a>         <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (!pageInfo.equals(other.pageInfo))
<a name="220" href="#220">220</a>         {
<a name="221" href="#221">221</a>             <strong class="jxr_keyword">return</strong> false;
<a name="222" href="#222">222</a>         }
<a name="223" href="#223">223</a>         <strong class="jxr_keyword">if</strong> (total != other.total)
<a name="224" href="#224">224</a>         {
<a name="225" href="#225">225</a>             <strong class="jxr_keyword">return</strong> false;
<a name="226" href="#226">226</a>         }
<a name="227" href="#227">227</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="228" href="#228">228</a>     }
<a name="229" href="#229">229</a> 
<a name="230" href="#230">230</a> 
<a name="231" href="#231">231</a>     <em class="jxr_javadoccomment">/**</em>
<a name="232" href="#232">232</a> <em class="jxr_javadoccomment">     * Returns a string representation in the form</em>
<a name="233" href="#233">233</a> <em class="jxr_javadoccomment">     * &lt;code&gt;PageResult[{@link PageInfo#getOffset()}/{@link #size()}/{@link #total()}/{@link #isNavigable()}]&lt;/code&gt;</em>
<a name="234" href="#234">234</a> <em class="jxr_javadoccomment">     * </em>
<a name="235" href="#235">235</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="236" href="#236">236</a> <em class="jxr_javadoccomment">     * @see java.lang.Object#toString()</em>
<a name="237" href="#237">237</a> <em class="jxr_javadoccomment">     */</em>
<a name="238" href="#238">238</a>     @Override
<a name="239" href="#239">239</a>     <strong class="jxr_keyword">public</strong> String toString()
<a name="240" href="#240">240</a>     {
<a name="241" href="#241">241</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> StringBuilder(<span class="jxr_string">"PageResult ["</span>).append(pageInfo.getOffset()).append(<span class="jxr_string">"/"</span>).append(size()).append(<span class="jxr_string">"/"</span>)
<a name="242" href="#242">242</a>                 .append(total()).append(<span class="jxr_string">"/"</span>).append(isNavigable()).append(<span class="jxr_string">"]"</span>).toString();
<a name="243" href="#243">243</a>     }
<a name="244" href="#244">244</a> 
<a name="245" href="#245">245</a> 
<a name="246" href="#246">246</a>     <em class="jxr_comment">// --------------------------------------------------------- helper methods</em>
<a name="247" href="#247">247</a> 
<a name="248" href="#248">248</a>     <em class="jxr_javadoccomment">/**</em>
<a name="249" href="#249">249</a> <em class="jxr_javadoccomment">     * Throws an {@link IllegalArgumentException} in case {@code pageInfo} is</em>
<a name="250" href="#250">250</a> <em class="jxr_javadoccomment">     * &lt;code&gt;null&lt;/code&gt;.</em>
<a name="251" href="#251">251</a> <em class="jxr_javadoccomment">     * </em>
<a name="252" href="#252">252</a> <em class="jxr_javadoccomment">     * @param pageInfo</em>
<a name="253" href="#253">253</a> <em class="jxr_javadoccomment">     *            The {@link PageInfo} instance to check.</em>
<a name="254" href="#254">254</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="255" href="#255">255</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException</em>
<a name="256" href="#256">256</a> <em class="jxr_javadoccomment">     *             if {@code pageInfo} is &lt;code&gt;null&lt;/code&gt;.</em>
<a name="257" href="#257">257</a> <em class="jxr_javadoccomment">     */</em>
<a name="258" href="#258">258</a>     <strong class="jxr_keyword">private</strong> <a href="../../../../../name/pehl/taoki/rest/paging/PageInfo.html">PageInfo</a> checkPageInfo(<strong class="jxr_keyword">final</strong> <a href="../../../../../name/pehl/taoki/rest/paging/PageInfo.html">PageInfo</a> pageInfo) <strong class="jxr_keyword">throws</strong> IllegalArgumentException
<a name="259" href="#259">259</a>     {
<a name="260" href="#260">260</a>         <strong class="jxr_keyword">if</strong> (pageInfo == <strong class="jxr_keyword">null</strong>)
<a name="261" href="#261">261</a>         {
<a name="262" href="#262">262</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"pageInfo must not be null"</span>);
<a name="263" href="#263">263</a>         }
<a name="264" href="#264">264</a>         <strong class="jxr_keyword">return</strong> pageInfo;
<a name="265" href="#265">265</a>     }
<a name="266" href="#266">266</a> 
<a name="267" href="#267">267</a> 
<a name="268" href="#268">268</a>     <em class="jxr_javadoccomment">/**</em>
<a name="269" href="#269">269</a> <em class="jxr_javadoccomment">     * Creates a sublist of the specified list according to the given</em>
<a name="270" href="#270">270</a> <em class="jxr_javadoccomment">     * {@link PageInfo} instance.</em>
<a name="271" href="#271">271</a> <em class="jxr_javadoccomment">     * </em>
<a name="272" href="#272">272</a> <em class="jxr_javadoccomment">     * @param pageInfo</em>
<a name="273" href="#273">273</a> <em class="jxr_javadoccomment">     *            The pageInfo instance which is used to create the sublist.</em>
<a name="274" href="#274">274</a> <em class="jxr_javadoccomment">     * @param all</em>
<a name="275" href="#275">275</a> <em class="jxr_javadoccomment">     *            The complete list.</em>
<a name="276" href="#276">276</a> <em class="jxr_javadoccomment">     * @return A sublist which contains only the data according to</em>
<a name="277" href="#277">277</a> <em class="jxr_javadoccomment">     *         {@code pageInfo}.</em>
<a name="278" href="#278">278</a> <em class="jxr_javadoccomment">     */</em>
<a name="279" href="#279">279</a>     <strong class="jxr_keyword">private</strong> List&lt;T&gt; sublist(<strong class="jxr_keyword">final</strong> <a href="../../../../../name/pehl/taoki/rest/paging/PageInfo.html">PageInfo</a> pageInfo, <strong class="jxr_keyword">final</strong> List&lt;T&gt; all)
<a name="280" href="#280">280</a>     {
<a name="281" href="#281">281</a>         <strong class="jxr_keyword">if</strong> (all.isEmpty())
<a name="282" href="#282">282</a>         {
<a name="283" href="#283">283</a>             <strong class="jxr_keyword">return</strong> Collections.emptyList();
<a name="284" href="#284">284</a>         }
<a name="285" href="#285">285</a>         <strong class="jxr_keyword">if</strong> (pageInfo.getOffset() == 0 &amp;&amp; all.size() &lt; pageInfo.getPageSize())
<a name="286" href="#286">286</a>         {
<a name="287" href="#287">287</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> ArrayList&lt;T&gt;(all);
<a name="288" href="#288">288</a>         }
<a name="289" href="#289">289</a> 
<a name="290" href="#290">290</a>         List&lt;T&gt; page = <strong class="jxr_keyword">new</strong> ArrayList&lt;T&gt;();
<a name="291" href="#291">291</a>         <strong class="jxr_keyword">int</strong> from = pageInfo.getOffset();
<a name="292" href="#292">292</a>         <strong class="jxr_keyword">int</strong> to = from + pageInfo.getPageSize();
<a name="293" href="#293">293</a>         <strong class="jxr_keyword">int</strong> size = all.size();
<a name="294" href="#294">294</a>         <strong class="jxr_keyword">if</strong> (from &gt;= size)
<a name="295" href="#295">295</a>         {
<a name="296" href="#296">296</a>             from = size - 1;
<a name="297" href="#297">297</a>         }
<a name="298" href="#298">298</a>         <strong class="jxr_keyword">if</strong> (to &gt; size)
<a name="299" href="#299">299</a>         {
<a name="300" href="#300">300</a>             to = size;
<a name="301" href="#301">301</a>         }
<a name="302" href="#302">302</a>         page.addAll(all.subList(from, to));
<a name="303" href="#303">303</a>         <strong class="jxr_keyword">return</strong> page;
<a name="304" href="#304">304</a>     }
<a name="305" href="#305">305</a> 
<a name="306" href="#306">306</a> 
<a name="307" href="#307">307</a>     <em class="jxr_comment">// ------------------------------------------------------------- navigation</em>
<a name="308" href="#308">308</a> 
<a name="309" href="#309">309</a>     <em class="jxr_javadoccomment">/**</em>
<a name="310" href="#310">310</a> <em class="jxr_javadoccomment">     * Returns the {@link PageResult} instance representing the first page if</em>
<a name="311" href="#311">311</a> <em class="jxr_javadoccomment">     * this instance is {@linkplain #isNavigable() navigable}, &lt;code&gt;null&lt;/code&gt;</em>
<a name="312" href="#312">312</a> <em class="jxr_javadoccomment">     * otherwise.</em>
<a name="313" href="#313">313</a> <em class="jxr_javadoccomment">     * </em>
<a name="314" href="#314">314</a> <em class="jxr_javadoccomment">     * @return the {@link PageResult} instance representing the first page if</em>
<a name="315" href="#315">315</a> <em class="jxr_javadoccomment">     *         this instance is {@linkplain #isNavigable() navigable},</em>
<a name="316" href="#316">316</a> <em class="jxr_javadoccomment">     *         &lt;code&gt;null&lt;/code&gt; otherwise.</em>
<a name="317" href="#317">317</a> <em class="jxr_javadoccomment">     */</em>
<a name="318" href="#318">318</a>     <strong class="jxr_keyword">public</strong> PageResult&lt;T&gt; first()
<a name="319" href="#319">319</a>     {
<a name="320" href="#320">320</a>         <strong class="jxr_keyword">if</strong> (isNavigable())
<a name="321" href="#321">321</a>         {
<a name="322" href="#322">322</a>             PageResult&lt;T&gt; first = <strong class="jxr_keyword">new</strong> PageResult&lt;T&gt;(<strong class="jxr_keyword">new</strong> <a href="../../../../../name/pehl/taoki/rest/paging/PageInfo.html">PageInfo</a>(0, pageInfo.getPageSize()), all);
<a name="323" href="#323">323</a>             <strong class="jxr_keyword">return</strong> first;
<a name="324" href="#324">324</a>         }
<a name="325" href="#325">325</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="326" href="#326">326</a>     }
<a name="327" href="#327">327</a> 
<a name="328" href="#328">328</a> 
<a name="329" href="#329">329</a>     <em class="jxr_javadoccomment">/**</em>
<a name="330" href="#330">330</a> <em class="jxr_javadoccomment">     * Returns &lt;code&gt;true&lt;/code&gt; if this instance is {@linkplain #isNavigable()</em>
<a name="331" href="#331">331</a> <em class="jxr_javadoccomment">     * navigable} and has a previous page, &lt;code&gt;false&lt;/code&gt; otherwise.</em>
<a name="332" href="#332">332</a> <em class="jxr_javadoccomment">     * </em>
<a name="333" href="#333">333</a> <em class="jxr_javadoccomment">     * @return &lt;code&gt;true&lt;/code&gt; if this instance is {@linkplain #isNavigable()</em>
<a name="334" href="#334">334</a> <em class="jxr_javadoccomment">     *         navigable} and has a previous page, &lt;code&gt;false&lt;/code&gt; otherwise.</em>
<a name="335" href="#335">335</a> <em class="jxr_javadoccomment">     */</em>
<a name="336" href="#336">336</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> hasPrevious()
<a name="337" href="#337">337</a>     {
<a name="338" href="#338">338</a>         <strong class="jxr_keyword">if</strong> (isNavigable())
<a name="339" href="#339">339</a>         {
<a name="340" href="#340">340</a>             <strong class="jxr_keyword">int</strong> previousOffset = pageInfo.getOffset() - pageInfo.getPageSize();
<a name="341" href="#341">341</a>             <strong class="jxr_keyword">return</strong> previousOffset &gt;= 0;
<a name="342" href="#342">342</a>         }
<a name="343" href="#343">343</a>         <strong class="jxr_keyword">return</strong> false;
<a name="344" href="#344">344</a>     }
<a name="345" href="#345">345</a> 
<a name="346" href="#346">346</a> 
<a name="347" href="#347">347</a>     <em class="jxr_javadoccomment">/**</em>
<a name="348" href="#348">348</a> <em class="jxr_javadoccomment">     * Returns the {@link PageResult} instance representing the previous page if</em>
<a name="349" href="#349">349</a> <em class="jxr_javadoccomment">     * this instance is {@linkplain #isNavigable() navigable}, &lt;code&gt;null&lt;/code&gt;</em>
<a name="350" href="#350">350</a> <em class="jxr_javadoccomment">     * otherwise.</em>
<a name="351" href="#351">351</a> <em class="jxr_javadoccomment">     * </em>
<a name="352" href="#352">352</a> <em class="jxr_javadoccomment">     * @return the {@link PageResult} instance representing the previous page if</em>
<a name="353" href="#353">353</a> <em class="jxr_javadoccomment">     *         this instance is {@linkplain #isNavigable() navigable},</em>
<a name="354" href="#354">354</a> <em class="jxr_javadoccomment">     *         &lt;code&gt;null&lt;/code&gt; otherwise.</em>
<a name="355" href="#355">355</a> <em class="jxr_javadoccomment">     */</em>
<a name="356" href="#356">356</a>     <strong class="jxr_keyword">public</strong> PageResult&lt;T&gt; previous()
<a name="357" href="#357">357</a>     {
<a name="358" href="#358">358</a>         <strong class="jxr_keyword">if</strong> (isNavigable())
<a name="359" href="#359">359</a>         {
<a name="360" href="#360">360</a>             PageResult&lt;T&gt; previous = <strong class="jxr_keyword">new</strong> PageResult&lt;T&gt;(pageInfo.previous(), all);
<a name="361" href="#361">361</a>             <strong class="jxr_keyword">return</strong> previous;
<a name="362" href="#362">362</a>         }
<a name="363" href="#363">363</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="364" href="#364">364</a>     }
<a name="365" href="#365">365</a> 
<a name="366" href="#366">366</a> 
<a name="367" href="#367">367</a>     <em class="jxr_javadoccomment">/**</em>
<a name="368" href="#368">368</a> <em class="jxr_javadoccomment">     * Returns the {@link PageResult} instance representing the page at the</em>
<a name="369" href="#369">369</a> <em class="jxr_javadoccomment">     * specified index if this instance is {@linkplain #isNavigable() navigable}</em>
<a name="370" href="#370">370</a> <em class="jxr_javadoccomment">     * , &lt;code&gt;null&lt;/code&gt; otherwise.</em>
<a name="371" href="#371">371</a> <em class="jxr_javadoccomment">     * </em>
<a name="372" href="#372">372</a> <em class="jxr_javadoccomment">     * @param index</em>
<a name="373" href="#373">373</a> <em class="jxr_javadoccomment">     *            the page index</em>
<a name="374" href="#374">374</a> <em class="jxr_javadoccomment">     * @return the {@link PageResult} instance representing the page at the</em>
<a name="375" href="#375">375</a> <em class="jxr_javadoccomment">     *         specified index if this instance is {@linkplain #isNavigable()</em>
<a name="376" href="#376">376</a> <em class="jxr_javadoccomment">     *         navigable}, &lt;code&gt;null&lt;/code&gt; otherwise.</em>
<a name="377" href="#377">377</a> <em class="jxr_javadoccomment">     * @throws IndexOutOfBoundsException</em>
<a name="378" href="#378">378</a> <em class="jxr_javadoccomment">     *             if {@code index} &amp;lt; 0 or &amp;gt; {@link #pages()} - 1</em>
<a name="379" href="#379">379</a> <em class="jxr_javadoccomment">     */</em>
<a name="380" href="#380">380</a>     <strong class="jxr_keyword">public</strong> PageResult&lt;T&gt; page(<strong class="jxr_keyword">int</strong> index)
<a name="381" href="#381">381</a>     {
<a name="382" href="#382">382</a>         <strong class="jxr_keyword">if</strong> (index &lt; 0 || index &gt; pages - 1)
<a name="383" href="#383">383</a>         {
<a name="384" href="#384">384</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IndexOutOfBoundsException(String.format(<span class="jxr_string">"Page index %d out of bounds. Valid range: [0, %d]"</span>,
<a name="385" href="#385">385</a>                     index, pages - 1));
<a name="386" href="#386">386</a>         }
<a name="387" href="#387">387</a>         <strong class="jxr_keyword">if</strong> (isNavigable())
<a name="388" href="#388">388</a>         {
<a name="389" href="#389">389</a>             <strong class="jxr_keyword">int</strong> offset = index * pageInfo.getPageSize();
<a name="390" href="#390">390</a>             PageResult&lt;T&gt; pageAtIndex = <strong class="jxr_keyword">new</strong> PageResult&lt;T&gt;(<strong class="jxr_keyword">new</strong> <a href="../../../../../name/pehl/taoki/rest/paging/PageInfo.html">PageInfo</a>(offset, pageInfo.getPageSize()), all);
<a name="391" href="#391">391</a>             <strong class="jxr_keyword">return</strong> pageAtIndex;
<a name="392" href="#392">392</a>         }
<a name="393" href="#393">393</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="394" href="#394">394</a>     }
<a name="395" href="#395">395</a> 
<a name="396" href="#396">396</a> 
<a name="397" href="#397">397</a>     <em class="jxr_javadoccomment">/**</em>
<a name="398" href="#398">398</a> <em class="jxr_javadoccomment">     * Returns &lt;code&gt;true&lt;/code&gt; if this instance is {@linkplain #isNavigable()</em>
<a name="399" href="#399">399</a> <em class="jxr_javadoccomment">     * navigable} and has a next page, &lt;code&gt;false&lt;/code&gt; otherwise.</em>
<a name="400" href="#400">400</a> <em class="jxr_javadoccomment">     * </em>
<a name="401" href="#401">401</a> <em class="jxr_javadoccomment">     * @return &lt;code&gt;true&lt;/code&gt; if this instance is {@linkplain #isNavigable()</em>
<a name="402" href="#402">402</a> <em class="jxr_javadoccomment">     *         navigable} and has a next page, &lt;code&gt;false&lt;/code&gt; otherwise.</em>
<a name="403" href="#403">403</a> <em class="jxr_javadoccomment">     */</em>
<a name="404" href="#404">404</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> hasNext()
<a name="405" href="#405">405</a>     {
<a name="406" href="#406">406</a>         <strong class="jxr_keyword">if</strong> (isNavigable())
<a name="407" href="#407">407</a>         {
<a name="408" href="#408">408</a>             <strong class="jxr_keyword">int</strong> nextOffset = pageInfo.getOffset() + pageInfo.getPageSize();
<a name="409" href="#409">409</a>             <strong class="jxr_keyword">return</strong> nextOffset &lt; total();
<a name="410" href="#410">410</a>         }
<a name="411" href="#411">411</a>         <strong class="jxr_keyword">return</strong> false;
<a name="412" href="#412">412</a>     }
<a name="413" href="#413">413</a> 
<a name="414" href="#414">414</a> 
<a name="415" href="#415">415</a>     <em class="jxr_javadoccomment">/**</em>
<a name="416" href="#416">416</a> <em class="jxr_javadoccomment">     * Returns the {@link PageResult} instance representing the next page if</em>
<a name="417" href="#417">417</a> <em class="jxr_javadoccomment">     * this instance is {@linkplain #isNavigable() navigable}, &lt;code&gt;null&lt;/code&gt;</em>
<a name="418" href="#418">418</a> <em class="jxr_javadoccomment">     * otherwise.</em>
<a name="419" href="#419">419</a> <em class="jxr_javadoccomment">     * </em>
<a name="420" href="#420">420</a> <em class="jxr_javadoccomment">     * @return the {@link PageResult} instance representing the next page if</em>
<a name="421" href="#421">421</a> <em class="jxr_javadoccomment">     *         this instance is {@linkplain #isNavigable() navigable},</em>
<a name="422" href="#422">422</a> <em class="jxr_javadoccomment">     *         &lt;code&gt;null&lt;/code&gt; otherwise.</em>
<a name="423" href="#423">423</a> <em class="jxr_javadoccomment">     */</em>
<a name="424" href="#424">424</a>     <strong class="jxr_keyword">public</strong> PageResult&lt;T&gt; next()
<a name="425" href="#425">425</a>     {
<a name="426" href="#426">426</a>         <strong class="jxr_keyword">if</strong> (isNavigable())
<a name="427" href="#427">427</a>         {
<a name="428" href="#428">428</a>             PageResult&lt;T&gt; next = <strong class="jxr_keyword">new</strong> PageResult&lt;T&gt;(pageInfo.next(), all);
<a name="429" href="#429">429</a>             <strong class="jxr_keyword">return</strong> next;
<a name="430" href="#430">430</a>         }
<a name="431" href="#431">431</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="432" href="#432">432</a>     }
<a name="433" href="#433">433</a> 
<a name="434" href="#434">434</a> 
<a name="435" href="#435">435</a>     <em class="jxr_javadoccomment">/**</em>
<a name="436" href="#436">436</a> <em class="jxr_javadoccomment">     * Returns the {@link PageResult} instance representing the last page if</em>
<a name="437" href="#437">437</a> <em class="jxr_javadoccomment">     * this instance is {@linkplain #isNavigable() navigable}, &lt;code&gt;null&lt;/code&gt;</em>
<a name="438" href="#438">438</a> <em class="jxr_javadoccomment">     * otherwise.</em>
<a name="439" href="#439">439</a> <em class="jxr_javadoccomment">     * </em>
<a name="440" href="#440">440</a> <em class="jxr_javadoccomment">     * @return the {@link PageResult} instance representing the last page if</em>
<a name="441" href="#441">441</a> <em class="jxr_javadoccomment">     *         this instance is {@linkplain #isNavigable() navigable},</em>
<a name="442" href="#442">442</a> <em class="jxr_javadoccomment">     *         &lt;code&gt;null&lt;/code&gt; otherwise.</em>
<a name="443" href="#443">443</a> <em class="jxr_javadoccomment">     */</em>
<a name="444" href="#444">444</a>     <strong class="jxr_keyword">public</strong> PageResult&lt;T&gt; last()
<a name="445" href="#445">445</a>     {
<a name="446" href="#446">446</a>         <strong class="jxr_keyword">if</strong> (isNavigable())
<a name="447" href="#447">447</a>         {
<a name="448" href="#448">448</a>             <strong class="jxr_keyword">int</strong> lastOffset = 0;
<a name="449" href="#449">449</a>             <strong class="jxr_keyword">if</strong> (total() &gt; pageInfo.getPageSize())
<a name="450" href="#450">450</a>             {
<a name="451" href="#451">451</a>                 <strong class="jxr_keyword">int</strong> remainder = total() % pageInfo.getPageSize();
<a name="452" href="#452">452</a>                 lastOffset = remainder != 0 ? total() - remainder : total() - pageInfo.getPageSize();
<a name="453" href="#453">453</a>             }
<a name="454" href="#454">454</a>             PageResult&lt;T&gt; last = <strong class="jxr_keyword">new</strong> PageResult&lt;T&gt;(<strong class="jxr_keyword">new</strong> <a href="../../../../../name/pehl/taoki/rest/paging/PageInfo.html">PageInfo</a>(lastOffset, pageInfo.getPageSize()), all);
<a name="455" href="#455">455</a>             <strong class="jxr_keyword">return</strong> last;
<a name="456" href="#456">456</a>         }
<a name="457" href="#457">457</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="458" href="#458">458</a>     }
<a name="459" href="#459">459</a> 
<a name="460" href="#460">460</a> 
<a name="461" href="#461">461</a>     <em class="jxr_comment">// ------------------------------------------------------------- properties</em>
<a name="462" href="#462">462</a> 
<a name="463" href="#463">463</a>     <em class="jxr_javadoccomment">/**</em>
<a name="464" href="#464">464</a> <em class="jxr_javadoccomment">     * Returns &lt;code&gt;true&lt;/code&gt; if this instance was created using</em>
<a name="465" href="#465">465</a> <em class="jxr_javadoccomment">     * {@link #PageResult(PageInfo, List)} and the {@code all} parameter was not</em>
<a name="466" href="#466">466</a> <em class="jxr_javadoccomment">     * &lt;code&gt;null&lt;/code&gt;. In this case the methods {@link #first()},</em>
<a name="467" href="#467">467</a> <em class="jxr_javadoccomment">     * {@link #previous()}, {@link #page(int)}, {@link #next()} and</em>
<a name="468" href="#468">468</a> <em class="jxr_javadoccomment">     * {@link #last()} will return a relevant {@link PageResult} instance.</em>
<a name="469" href="#469">469</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="470" href="#470">470</a> <em class="jxr_javadoccomment">     * If this instance was created using</em>
<a name="471" href="#471">471</a> <em class="jxr_javadoccomment">     * {@link #PageResult(PageInfo, List, int)} the method returns</em>
<a name="472" href="#472">472</a> <em class="jxr_javadoccomment">     * &lt;code&gt;false&lt;/code&gt;. In this case the methods {@link #first()},</em>
<a name="473" href="#473">473</a> <em class="jxr_javadoccomment">     * {@link #previous()}, {@link #page(int)}, {@link #next()} and</em>
<a name="474" href="#474">474</a> <em class="jxr_javadoccomment">     * {@link #last()} will all return &lt;code&gt;null&lt;/code&gt;.</em>
<a name="475" href="#475">475</a> <em class="jxr_javadoccomment">     * </em>
<a name="476" href="#476">476</a> <em class="jxr_javadoccomment">     * @return &lt;code&gt;true&lt;/code&gt; if this {@link PageResult} is navigable,</em>
<a name="477" href="#477">477</a> <em class="jxr_javadoccomment">     *         &lt;code&gt;false&lt;/code&gt; otherwise.</em>
<a name="478" href="#478">478</a> <em class="jxr_javadoccomment">     */</em>
<a name="479" href="#479">479</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isNavigable()
<a name="480" href="#480">480</a>     {
<a name="481" href="#481">481</a>         <strong class="jxr_keyword">return</strong> all != <strong class="jxr_keyword">null</strong>;
<a name="482" href="#482">482</a>     }
<a name="483" href="#483">483</a> 
<a name="484" href="#484">484</a> 
<a name="485" href="#485">485</a>     <em class="jxr_javadoccomment">/**</em>
<a name="486" href="#486">486</a> <em class="jxr_javadoccomment">     * Returns the data which reflects the current page of this</em>
<a name="487" href="#487">487</a> <em class="jxr_javadoccomment">     * {@link PageResult} instance.</em>
<a name="488" href="#488">488</a> <em class="jxr_javadoccomment">     * </em>
<a name="489" href="#489">489</a> <em class="jxr_javadoccomment">     * @return the current page data.</em>
<a name="490" href="#490">490</a> <em class="jxr_javadoccomment">     */</em>
<a name="491" href="#491">491</a>     <strong class="jxr_keyword">public</strong> List&lt;T&gt; page()
<a name="492" href="#492">492</a>     {
<a name="493" href="#493">493</a>         <strong class="jxr_keyword">return</strong> page;
<a name="494" href="#494">494</a>     }
<a name="495" href="#495">495</a> 
<a name="496" href="#496">496</a> 
<a name="497" href="#497">497</a>     <em class="jxr_javadoccomment">/**</em>
<a name="498" href="#498">498</a> <em class="jxr_javadoccomment">     * If this instance contains no data, the method returns 0. If it does the</em>
<a name="499" href="#499">499</a> <em class="jxr_javadoccomment">     * method returns the number of pages if this instance was created using</em>
<a name="500" href="#500">500</a> <em class="jxr_javadoccomment">     * {@link #PageResult(PageInfo, List)}. Otherwise the method returns 1.</em>
<a name="501" href="#501">501</a> <em class="jxr_javadoccomment">     * </em>
<a name="502" href="#502">502</a> <em class="jxr_javadoccomment">     * @return the number of pages.</em>
<a name="503" href="#503">503</a> <em class="jxr_javadoccomment">     */</em>
<a name="504" href="#504">504</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> pages()
<a name="505" href="#505">505</a>     {
<a name="506" href="#506">506</a>         <strong class="jxr_keyword">return</strong> pages;
<a name="507" href="#507">507</a>     }
<a name="508" href="#508">508</a> 
<a name="509" href="#509">509</a> 
<a name="510" href="#510">510</a>     <em class="jxr_javadoccomment">/**</em>
<a name="511" href="#511">511</a> <em class="jxr_javadoccomment">     * The total number of records.</em>
<a name="512" href="#512">512</a> <em class="jxr_javadoccomment">     * </em>
<a name="513" href="#513">513</a> <em class="jxr_javadoccomment">     * @return the total number of records.</em>
<a name="514" href="#514">514</a> <em class="jxr_javadoccomment">     */</em>
<a name="515" href="#515">515</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> total()
<a name="516" href="#516">516</a>     {
<a name="517" href="#517">517</a>         <strong class="jxr_keyword">return</strong> total;
<a name="518" href="#518">518</a>     }
<a name="519" href="#519">519</a> 
<a name="520" href="#520">520</a> 
<a name="521" href="#521">521</a>     <em class="jxr_comment">// -------------------------------------------------- page delegate methods</em>
<a name="522" href="#522">522</a> 
<a name="523" href="#523">523</a>     <em class="jxr_javadoccomment">/**</em>
<a name="524" href="#524">524</a> <em class="jxr_javadoccomment">     * Delegates to &lt;code&gt;{@link #page()}.iterator()&lt;/code&gt;.</em>
<a name="525" href="#525">525</a> <em class="jxr_javadoccomment">     * </em>
<a name="526" href="#526">526</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="527" href="#527">527</a> <em class="jxr_javadoccomment">     * @see List#iterator()</em>
<a name="528" href="#528">528</a> <em class="jxr_javadoccomment">     */</em>
<a name="529" href="#529">529</a>     @Override
<a name="530" href="#530">530</a>     <strong class="jxr_keyword">public</strong> Iterator&lt;T&gt; iterator()
<a name="531" href="#531">531</a>     {
<a name="532" href="#532">532</a>         <strong class="jxr_keyword">return</strong> page.iterator();
<a name="533" href="#533">533</a>     }
<a name="534" href="#534">534</a> 
<a name="535" href="#535">535</a> 
<a name="536" href="#536">536</a>     <em class="jxr_javadoccomment">/**</em>
<a name="537" href="#537">537</a> <em class="jxr_javadoccomment">     * Delegates to &lt;code&gt;{@link #page()}.size()&lt;/code&gt;.</em>
<a name="538" href="#538">538</a> <em class="jxr_javadoccomment">     * </em>
<a name="539" href="#539">539</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="540" href="#540">540</a> <em class="jxr_javadoccomment">     * @see List#size()</em>
<a name="541" href="#541">541</a> <em class="jxr_javadoccomment">     */</em>
<a name="542" href="#542">542</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> size()
<a name="543" href="#543">543</a>     {
<a name="544" href="#544">544</a>         <strong class="jxr_keyword">return</strong> page.size();
<a name="545" href="#545">545</a>     }
<a name="546" href="#546">546</a> 
<a name="547" href="#547">547</a> 
<a name="548" href="#548">548</a>     <em class="jxr_javadoccomment">/**</em>
<a name="549" href="#549">549</a> <em class="jxr_javadoccomment">     * Delegates to &lt;code&gt;{@link #page()}.isEmpty()&lt;/code&gt;.</em>
<a name="550" href="#550">550</a> <em class="jxr_javadoccomment">     * </em>
<a name="551" href="#551">551</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="552" href="#552">552</a> <em class="jxr_javadoccomment">     * @see List#isEmpty()</em>
<a name="553" href="#553">553</a> <em class="jxr_javadoccomment">     */</em>
<a name="554" href="#554">554</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isEmpty()
<a name="555" href="#555">555</a>     {
<a name="556" href="#556">556</a>         <strong class="jxr_keyword">return</strong> page.isEmpty();
<a name="557" href="#557">557</a>     }
<a name="558" href="#558">558</a> 
<a name="559" href="#559">559</a> 
<a name="560" href="#560">560</a>     <em class="jxr_javadoccomment">/**</em>
<a name="561" href="#561">561</a> <em class="jxr_javadoccomment">     * Delegates to &lt;code&gt;{@link #page()}.contains()&lt;/code&gt;.</em>
<a name="562" href="#562">562</a> <em class="jxr_javadoccomment">     * </em>
<a name="563" href="#563">563</a> <em class="jxr_javadoccomment">     * @param o</em>
<a name="564" href="#564">564</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="565" href="#565">565</a> <em class="jxr_javadoccomment">     * @see List#contains(Object)</em>
<a name="566" href="#566">566</a> <em class="jxr_javadoccomment">     */</em>
<a name="567" href="#567">567</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> contains(Object o)
<a name="568" href="#568">568</a>     {
<a name="569" href="#569">569</a>         <strong class="jxr_keyword">return</strong> page.contains(o);
<a name="570" href="#570">570</a>     }
<a name="571" href="#571">571</a> 
<a name="572" href="#572">572</a> 
<a name="573" href="#573">573</a>     <em class="jxr_javadoccomment">/**</em>
<a name="574" href="#574">574</a> <em class="jxr_javadoccomment">     * Delegates to &lt;code&gt;{@link #page()}.toArray()&lt;/code&gt;.</em>
<a name="575" href="#575">575</a> <em class="jxr_javadoccomment">     * </em>
<a name="576" href="#576">576</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="577" href="#577">577</a> <em class="jxr_javadoccomment">     * @see List#toArray()</em>
<a name="578" href="#578">578</a> <em class="jxr_javadoccomment">     */</em>
<a name="579" href="#579">579</a>     <strong class="jxr_keyword">public</strong> Object[] toArray()
<a name="580" href="#580">580</a>     {
<a name="581" href="#581">581</a>         <strong class="jxr_keyword">return</strong> page.toArray();
<a name="582" href="#582">582</a>     }
<a name="583" href="#583">583</a> 
<a name="584" href="#584">584</a> 
<a name="585" href="#585">585</a>     <em class="jxr_javadoccomment">/**</em>
<a name="586" href="#586">586</a> <em class="jxr_javadoccomment">     * Delegates to &lt;code&gt;{@link #page()}.toArray(T[])&lt;/code&gt;.</em>
<a name="587" href="#587">587</a> <em class="jxr_javadoccomment">     * </em>
<a name="588" href="#588">588</a> <em class="jxr_javadoccomment">     * @param a</em>
<a name="589" href="#589">589</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="590" href="#590">590</a> <em class="jxr_javadoccomment">     * @see List#toArray(Object[])</em>
<a name="591" href="#591">591</a> <em class="jxr_javadoccomment">     */</em>
<a name="592" href="#592">592</a>     <strong class="jxr_keyword">public</strong> T[] toArray(T[] a)
<a name="593" href="#593">593</a>     {
<a name="594" href="#594">594</a>         <strong class="jxr_keyword">return</strong> page.toArray(a);
<a name="595" href="#595">595</a>     }
<a name="596" href="#596">596</a> 
<a name="597" href="#597">597</a> 
<a name="598" href="#598">598</a>     <em class="jxr_javadoccomment">/**</em>
<a name="599" href="#599">599</a> <em class="jxr_javadoccomment">     * Delegates to &lt;code&gt;{@link #page()}.containsAll(Collection&lt;?&gt;)&lt;/code&gt;.</em>
<a name="600" href="#600">600</a> <em class="jxr_javadoccomment">     * </em>
<a name="601" href="#601">601</a> <em class="jxr_javadoccomment">     * @param c</em>
<a name="602" href="#602">602</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="603" href="#603">603</a> <em class="jxr_javadoccomment">     * @see List#containsAll(Collection)</em>
<a name="604" href="#604">604</a> <em class="jxr_javadoccomment">     */</em>
<a name="605" href="#605">605</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> containsAll(Collection&lt;?&gt; c)
<a name="606" href="#606">606</a>     {
<a name="607" href="#607">607</a>         <strong class="jxr_keyword">return</strong> page.containsAll(c);
<a name="608" href="#608">608</a>     }
<a name="609" href="#609">609</a> 
<a name="610" href="#610">610</a> 
<a name="611" href="#611">611</a>     <em class="jxr_javadoccomment">/**</em>
<a name="612" href="#612">612</a> <em class="jxr_javadoccomment">     * Delegates to &lt;code&gt;{@link #page()}.get(int)&lt;/code&gt;.</em>
<a name="613" href="#613">613</a> <em class="jxr_javadoccomment">     * </em>
<a name="614" href="#614">614</a> <em class="jxr_javadoccomment">     * @param index</em>
<a name="615" href="#615">615</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="616" href="#616">616</a> <em class="jxr_javadoccomment">     * @see List#get(int)</em>
<a name="617" href="#617">617</a> <em class="jxr_javadoccomment">     */</em>
<a name="618" href="#618">618</a>     <strong class="jxr_keyword">public</strong> T get(<strong class="jxr_keyword">int</strong> index)
<a name="619" href="#619">619</a>     {
<a name="620" href="#620">620</a>         <strong class="jxr_keyword">return</strong> page.get(index);
<a name="621" href="#621">621</a>     }
<a name="622" href="#622">622</a> 
<a name="623" href="#623">623</a> 
<a name="624" href="#624">624</a>     <em class="jxr_javadoccomment">/**</em>
<a name="625" href="#625">625</a> <em class="jxr_javadoccomment">     * Delegates to &lt;code&gt;{@link #page()}.indexOf(Object)&lt;/code&gt;.</em>
<a name="626" href="#626">626</a> <em class="jxr_javadoccomment">     * </em>
<a name="627" href="#627">627</a> <em class="jxr_javadoccomment">     * @param o</em>
<a name="628" href="#628">628</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="629" href="#629">629</a> <em class="jxr_javadoccomment">     * @see List#indexOf(Object)</em>
<a name="630" href="#630">630</a> <em class="jxr_javadoccomment">     */</em>
<a name="631" href="#631">631</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> indexOf(Object o)
<a name="632" href="#632">632</a>     {
<a name="633" href="#633">633</a>         <strong class="jxr_keyword">return</strong> page.indexOf(o);
<a name="634" href="#634">634</a>     }
<a name="635" href="#635">635</a> 
<a name="636" href="#636">636</a> 
<a name="637" href="#637">637</a>     <em class="jxr_javadoccomment">/**</em>
<a name="638" href="#638">638</a> <em class="jxr_javadoccomment">     * Delegates to &lt;code&gt;{@link #page()}.lastIndexOf(Object)&lt;/code&gt;.</em>
<a name="639" href="#639">639</a> <em class="jxr_javadoccomment">     * </em>
<a name="640" href="#640">640</a> <em class="jxr_javadoccomment">     * @param o</em>
<a name="641" href="#641">641</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="642" href="#642">642</a> <em class="jxr_javadoccomment">     * @see List#lastIndexOf(Object)</em>
<a name="643" href="#643">643</a> <em class="jxr_javadoccomment">     */</em>
<a name="644" href="#644">644</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> lastIndexOf(Object o)
<a name="645" href="#645">645</a>     {
<a name="646" href="#646">646</a>         <strong class="jxr_keyword">return</strong> page.lastIndexOf(o);
<a name="647" href="#647">647</a>     }
<a name="648" href="#648">648</a> 
<a name="649" href="#649">649</a> 
<a name="650" href="#650">650</a>     <em class="jxr_javadoccomment">/**</em>
<a name="651" href="#651">651</a> <em class="jxr_javadoccomment">     * Delegates to &lt;code&gt;{@link #page()}.listIterator()&lt;/code&gt;.</em>
<a name="652" href="#652">652</a> <em class="jxr_javadoccomment">     * </em>
<a name="653" href="#653">653</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="654" href="#654">654</a> <em class="jxr_javadoccomment">     * @see List#listIterator()</em>
<a name="655" href="#655">655</a> <em class="jxr_javadoccomment">     */</em>
<a name="656" href="#656">656</a>     <strong class="jxr_keyword">public</strong> ListIterator&lt;T&gt; listIterator()
<a name="657" href="#657">657</a>     {
<a name="658" href="#658">658</a>         <strong class="jxr_keyword">return</strong> page.listIterator();
<a name="659" href="#659">659</a>     }
<a name="660" href="#660">660</a> 
<a name="661" href="#661">661</a> 
<a name="662" href="#662">662</a>     <em class="jxr_javadoccomment">/**</em>
<a name="663" href="#663">663</a> <em class="jxr_javadoccomment">     * Delegates to &lt;code&gt;{@link #page()}.listIterator(int)&lt;/code&gt;.</em>
<a name="664" href="#664">664</a> <em class="jxr_javadoccomment">     * </em>
<a name="665" href="#665">665</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="666" href="#666">666</a> <em class="jxr_javadoccomment">     * @see List#listIterator(int)</em>
<a name="667" href="#667">667</a> <em class="jxr_javadoccomment">     */</em>
<a name="668" href="#668">668</a>     <strong class="jxr_keyword">public</strong> ListIterator&lt;T&gt; listIterator(<strong class="jxr_keyword">int</strong> index)
<a name="669" href="#669">669</a>     {
<a name="670" href="#670">670</a>         <strong class="jxr_keyword">return</strong> page.listIterator(index);
<a name="671" href="#671">671</a>     }
<a name="672" href="#672">672</a> 
<a name="673" href="#673">673</a> 
<a name="674" href="#674">674</a>     <em class="jxr_javadoccomment">/**</em>
<a name="675" href="#675">675</a> <em class="jxr_javadoccomment">     * Delegates to &lt;code&gt;{@link #page()}.subList(int, int)&lt;/code&gt;.</em>
<a name="676" href="#676">676</a> <em class="jxr_javadoccomment">     * </em>
<a name="677" href="#677">677</a> <em class="jxr_javadoccomment">     * @param fromIndex</em>
<a name="678" href="#678">678</a> <em class="jxr_javadoccomment">     * @param toIndex</em>
<a name="679" href="#679">679</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="680" href="#680">680</a> <em class="jxr_javadoccomment">     * @see List#subList(int, int)</em>
<a name="681" href="#681">681</a> <em class="jxr_javadoccomment">     */</em>
<a name="682" href="#682">682</a>     <strong class="jxr_keyword">public</strong> List&lt;T&gt; subList(<strong class="jxr_keyword">int</strong> fromIndex, <strong class="jxr_keyword">int</strong> toIndex)
<a name="683" href="#683">683</a>     {
<a name="684" href="#684">684</a>         <strong class="jxr_keyword">return</strong> page.subList(fromIndex, toIndex);
<a name="685" href="#685">685</a>     }
<a name="686" href="#686">686</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

